package org.dromara.common.ratelimiter.annotation;

import org.dromara.common.ratelimiter.enums.LimitType;

import java.lang.annotation.*;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：限流注解
 */
// 定义了注解的使用范围，该注解只能用于方法上。
@Target(ElementType.METHOD)
// 指定注解的保留策略，该注解将在运行时保留。
@Retention(RetentionPolicy.RUNTIME)
// 指定注解将被包含在文档中，用于生成API文档等。
@Documented
public @interface RateLimiter {
    /**
     * 限流key,支持使用Spring el表达式来动态获取方法上的参数值
     * 格式类似于  #code.id #{#code}
     */
    String key() default "";

    /**
     * 限流时间,单位秒
     */
    int time() default 60;

    /**
     * 限流次数
     */
    int count() default 100;

    /**
     * 限流类型
     */
    LimitType limitType() default LimitType.DEFAULT;

    /**
     * 提示消息 支持国际化 格式为 {code}
     */
    String message() default "{rate.limiter.message}";
}
